Aminet 2

home *** CD-ROM | disk | FTP | other *** search

/ Aminet 2 / Aminet AMIGA CDROM (1994)(Walnut Creek)[Feb 1994][W.O. 44790-1].iso / Aminet / util / shell / SphinxExtraDocs.lha / Docs / Configuration.doc < prev next >

Wrap

Text File | 1992-05-16 | 11.8 KB | 339 lines

Sphinx.doc v2.5b © 1992, Nicolas Dade. All Rights Reserved permission is hereby granted for non-commercial duplication and distribution doc file for the SPHINX: AmigaDOS device last revised: May 16th, 1992 First, to open the configuration window, press RA-C (RightAmiga-C). (If the config window is already open, this brings it to the front). Then the various gadgets are: In the right handle column: [Input Text] [Wd Detail] [Wd Block] These let you set the colors of each of these. There are 8 color gadgets because the bottom 4 are colors 4-7 if your workbench has more than 4 colors. Wd Detail and Wd Block colors aren't so dramatic under 2.0 as they where under 1.3. [Input Font] [Write Font] These let you set the font to be used for input text or for written text. They bring up a requester which looks like: Name _____________ Height ____ Line Height ____ [Done] [Cancel] Enter the name of the font in the name gadget. ".font" is added to the name if it is not already present. Enter the height of the font in the height gadget. Enter the height of the lines in the window in the Line Height gadget. This is the minimum pixel height of lines, which allows you to space a scrunched font a bit if you set it to something greater than the font's height. If any of the fonts actually used (if the fonts you specify cannot be found or used, defaults are used) is taller than line height, then the height of that font is used for the line spacing. The line height gadget in the two font requesters edits the same number. If no name is given then a default font is found, which allows you to go back to the default by clearing the name. The font specified must be fixed width (non-proportional). Proportional fonts are prettier but are a nightmare for the programmer (unless you dont't want speed). NOTES: 1)the font names and heights are optional 2)these fonts are looked for and tested in this order, and the first suitable one is used: if a font was specified the user's font in ram (OpenFont()) the user's font on disk (OpenDiskFont()) ; if diskfont.library not found, ; alert : ODFt ; if no font is found, alert : ?FNT, where ? = W or I, depending on the ; font, and after the alert is canceled, continues to look for a font ; if a font is found, but its flags are wrong, then alert : ?FFg, then ; continue to look for a font (it is a proportion font, or etc...) ; if a font is found, but its width is zero, then alert : ?FWt, then ; continue to look for a font then, in any case the window's rasterport's font (rp_Font) the window's font (IFont) the screen's font (sc_Font) the system default (gb_DefaultFont) and if none of these are suitable, then Topaz/8 is checked. ; if topaz/8 is not found, then alert : TpNF, and shutdown ; if topaz/8's flags are wrong, then alert : TpFg, and shutdown ; if topaz/8's width is zero, then alert : TpWt, and shutdown 3)if a font name is given, the corresponding font height MUST be given too. 4)there is nothing wrong with specifying the same font for both input and writing. 5)both fonts must be non-proportional (proportional fonts may look nice and be easier to read but they are much too much of a pain for the programer), and have non-zero widths. 6)the fonts do not have to have the same width or height. [Y/N Options] brings up a pannel full of options which can be toggled on and off. [C-Fn Lines] brings up a pannel which lets you edit the lines which are inserted when C-F1 through C-F10 are pressed. [CharStrings] brings up a pannel which lets you edit the file names for clipping and inserting, the bell's sound file, the extra characters considered to be part of a word when doing various things, and the minimum length the input/search line must have before a fragment comparison will be tried. [Buffer Size] brings up a pannel which lets you edit the size of the scroll back buffers, the size of the write save, the size of the chunk of memory, and the width of the iconized window. [Load Config] if arp.library can be found, opens a file requester and gets a filename from there, or else it uses the filename of the config in use (either the default config, or that specified in the opening string by /SPHINXCONFIG). In either case the config in the specified file is loaded. The config loader does do some sanity checking on the file. [Save Config] gets a filename the same way [Load Config] does, and saves the current configuration to it. The across the bottom, some cycle gadgets: [Clip To Xxxxx] Cycles throught the clipping destinations, just like RA-G does in the sphinc window. (Clip To Window=private) [Xxxxx Cursor] Cycles through the various cursor imageries available. [Xxxxx Clip File] Decides whether to append or to overwrite the clip file when a clip is made. [Iconizing Allowed] Lets you turn iconizing back on if it was disabled due to a DiskInfo packet. (To keep DiskInfo packets from turning iconizing off, select the Always Allow Iconizing option). And now the pannels: the Y/N Options pannel: (options are selected when the hand is pointing to them) Parse Inserts same as RA-P Output Blocked same as C-S No Automatic Scrolling same as SC-S Ring Bell When Input Expected same as RA-B Next Char Taken Literally same as RA-L Lie About Window Height Sphinx tries to convince programs which inquire about the height of its window that the window is 999 lines high. This cuts down the number of times you have to press Return to get the next screen- full in programs which paginate their output. NOTE: I can't seem to fool LhA. Half Window Scroll When the cursor goes past the bottom of the window because of text written to the window, instead of scrolling just enough to put bring it back into view, sphinx scrolls it to the center line of the window. This reduces the number of scrolls which takes place, and consiquently increases the speed of the output, and consiquently the speed of the outputting program too. Consider leaving this selected when using programs which dump many lines of output, like DiskCopy, Format, archivers, and dir/list/ls. Center Cursor If the cursor goes out of sight because of editing in the input line, scroll enough so that the cursor is on the center line of the window, instead of just enough to bring it back into sight. This really only shows up when you have a very small window and/or a long input line. Iconized Has Depth Gadget Adds a depth gadget to the iconized window. Iconized Auto To Back The iconized window goes to the back automatically. 1 Pixel Thicker Borders Adds a 1 pixel blank border around the text area. This is usefull with WB2.0 since the 2.0 window borders touch the text if this is not selected, and that is not always pretty. Monochrome Text Area This forces all color change control codes to be ignored (they are saved, so if/when you unselect this the output comes out as it really is supposed to be) , and the color of the input lines to be color 1, etc... . The idea is that since everything is color 1 on color 0, only bitplane 0 has to be written to and scrolled when rendering in the text area, which speeds things up. This option alone will almost double the scrolling speed of the window for one-line scrolls (C-UP and C-DOWN) since it halves the amount of data which has to be moved (assuming 4 color wb). (things get even better with 8 and 16 color WBs). Always Allow Iconizing DiskInfo packets do not disable iconizing. the C-Fn Lines pannel C-F1 the text which is inserted at the cursor when C-F1 is pressed. C-F2 must I explain all of these? I don't think so. . . . C-F10 stll the same. the CharStrings pannel: Initial File Names Clip File this is the file to which file clips are written. Insert File this is the file from which file inserts are read. If you have the arp.library then this is the filename you are first promted with. Bell Sound File this is the full path+file name of an iff one-shot 8 bits/sample file that is loaded and played when the first BELL (ctrl-G) is written (Write()) to any SPHINX window. thereafter the file is not reloaded, even if the window that caused it to load is closed; the file is shared between SPHINX's with the same BELLFilename in their configuration. This will allow you save CHIP ram if you have differently configured SPHINXs, since, if you specify the same Bell Sound file name they will all use the same sample and you won't have various copies lying around in CHIP ram. This is optional, and if this line is blank, then DisplayBeep() is called when a BELL is found, like CON: and NEWCON:. Extra Characters Allowed in a Word these four next gadgets allow you to specify characters which, in addition to a through z and A through Z, are considered to be part of a word when performing various operations. Move L/R a Word i.e. ALT-LEFT or RIGHT Delete a Word i.e. ALT-BACKSPACE or DELETE Clip a Word i.e. double-clicking with the mouse on a word Finish a Word i.e. RightAmiga-W Min Lngth for Fragment Comparison minimun length of an input/search line must have before the fragment comparison will be tried. This is controlable because the fragment comparison, when given a small fragment, will tend to match a lot of lines which aren't the one you're looking for (i.e. given one character it will give back very line which contains that character), so it is usually not good to use it for very short lines, hence this config option. Setting this to 1 causes the fragment conparison to always be tried, as you might think. Setting this to something larger than 256 effectively disables the fragment comparison, since the input lines cannot be longer than 256 characters. the Buffer Size pannel: Min X to Save at least is many or much of the specified thing will be kept in the scrollback buffer. In other words, sphinx will start deleting when input saves when more than <KBytes of Input> kbytes of input and more than <Input Saves> input saves are in the buffer. KBytes of Input memory used to store the input saves. Input Saves number of old input lines KBytes of Write memory used to store the written text. Write Saves blocks of written text between input lines, or 32K, whichever comes first. Setting these to 0 effectively disables buffering for that type of text-- the text will be lost once it scrolls off the top of the window. Setting these to 32767 gives you 32 Megs of buffer, which is a reasonable approximation to infinity as far as sphinx is concerned. (Current) shows the KBytes or number currently in the buffer. Min Size of this gives the minimum size of the object specified, in KBytes Write Save the "buffer" for the written text which goes between the previous input line and the input line being constructed. It is best if this is about the same size as the amout of text outputed between input lines. If it is smaller than a single Write() then a larger size is used, and the largest of those sizes is displayed in the (Reached) column, but multiple small Write()s will give you many small writesaves. WARNING: This must not he set to larger than 31K!!! Memory Chunk Sphinx takes memory from the system's free memory list in chunks, and then used each chunk in little pieces using its own, internal, free- memory-in-the-chunks memory handler (this also lets sphinx to things which are illegal with the AllocMem()/FreeMem() calls, like free the tail of a too large alloc). This gadget lets you set the size of the chunks. This is usefull if you are trying to keep sphinx from fragmenting your memory: let sphinx use very large chunks (64K) and it won't need to take very many. If the chunk size is too small for the amount of memory sphinx needs, sphinx will allocate a chunk which has exactly the needed size. The size of the largest of such chunks is displayed in the (Reached) column. Iconized Wd Width width if iconized window in pixels. If you specify 1 you'll get a _very_ thin window, which is quite hard to click on if you don't have a magnifying lens program running. You cannot specify something too large.